home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / CLEARC11.ARJ / CLEARC.DOC < prev    next >
Text File  |  1992-05-18  |  7KB  |  171 lines
  1.  
  2.  
  3.      ClearC V1.1
  4.  
  5.      Invariant Software
  6.      P.O. Box 10206
  7.      Spokane, WA  99209
  8.      509-327-2154 (Greg)
  9.  
  10.      INTRODUCTION
  11.         ClearC is intended for C programmers to help make C program files 
  12.      more legible by spacing operators, function calls and control guards,
  13.      and by reformatting the code to a specified style and indentation 
  14.      preference.  ClearC works with ANSI Standard C program files.  ClearC
  15.      is comprised of the following files:
  16.          CLEARC.EXE       Executable file.
  17.          CLEARC.DOC       User manual.
  18.          INVOICE.DOC      Registration. 
  19.          CLCSETUP.DAT     Data file for format parameters.
  20.          READ.ME          Brief description and instructions.
  21.          SAMPLE.C         C program file for testing ClearC.
  22.  
  23.      VERSION 1.1 VERSUS VERSION 1.0:
  24.         ClearC version 1.0 had a restriction on the function size in a
  25.      module of 20k - the program bombed!  Version 1.1 allows a maximum
  26.      function size of 60k.
  27.  
  28.      ClearC is SHAREWARE
  29.         ClearC is distributed as Shareware.  This means that ClearC is
  30.      commercial software distributed on a try before you pay basis.
  31.      Try ClearC for a couple of weeks, then if you find it useful register 
  32.      it.
  33.      
  34.      REGISTRATION and BENEFITS
  35.         All that is required is a one time registration fee of $30.
  36.      For your $30 you will receive telephone support, announcements of 
  37.      enhancements and future versions of ClearC, and any other Shareware 
  38.      released by Invariant Software.
  39.  
  40.      INSTALLATION
  41.         To make ClearC the most useful, copy the CLEARC.EXE and CLCSETUP.DAT
  42.      files to a directory that is pointed to by the PATH statement used 
  43.      by your DOS.  This statement is located in your AUTOEXEC.BAT.  ClearC
  44.      requires a PC compatible computer and 360K of memory.
  45.      
  46.      USING ClearC
  47.         CALLING from DOS
  48.            syntax:  clearc [drive:][path]filename [*.extension]
  49.  
  50.            Examples:
  51.               clearc file1.c                {original file overwritten}
  52.               clearc c:\src\file1.c
  53.               clearc *.c
  54.               clearc file1.c *.fmt          {formatted file "file1.fmt"}
  55.               clearc c:\src\*.c *.fmt
  56.               clearc *.c *.e
  57.  
  58.            Note: The file extension option must be of the form "*.XXX".  If
  59.            the file extension option is not exercised the formatted file 
  60.            will overwrite the original file.
  61.  
  62.         RESTRICTIONS
  63.            All files must be ASCII text files, meet the ANSI Standard for C,
  64.         and be syntax-error-free files.  If syntax errors exist, a 
  65.         runtime error may occur; however, your original file will not 
  66.         be altered.
  67.            Program comments are not affected except for positioning.  The
  68.         following operators are not altered because of double meanings
  69.         and cosmetic reasons: '!', '&', '*', '**', '++', '--', '->' and '~'.
  70.            All functions within a module must not be larger than 60k bytes
  71.         in size or an error message will be displayed and the program is
  72.         terminated.  
  73.                 
  74.  
  75.         USER INTERFACE
  76.            If valid arguments were given the initial screen is displayed
  77.         with the default format parameters.  The parameters represent your 
  78.         last use of the program and are saved in CLCSETUP.dat.
  79.            The screen is made up of four sections - indentation spaces, 
  80.         function style selection, control style selection, and character
  81.         spacing.  All possible key actions are detailed in the box at the
  82.         bottom of the screen.  Press <Enter> to move from one section to
  83.         another, press <Esc> to terminate the program, and press <CTRL-R>
  84.         to run formatting.
  85.  
  86.         Indentation spaces:  Press '1','2','3',... or '9' to change 
  87.         indentation.
  88.  
  89.         Function Style and Control Style:  Use up and down arrows to select
  90.         the desired style.
  91.  
  92.         Spacing:  A 'space' character is marked with a '^' underneath and
  93.         designates movable characters so that the desired spacing can be
  94.         expressed.  A 'space' character can be moved to the left (if a
  95.         blank space exists to the left) or to the right using the 
  96.         <backspace> and <space bar> respectively.  The cursor is moved
  97.         from one 'space' character to another using arrow keys.
  98.      
  99.      DISCLAIMER
  100.         Invariant Software disclaims all warranties, expressed or implied,
  101.      relating to this product as to the merchantability and/or fitness for
  102.      a particular purpose.  Invariant Software shall not be liable for 
  103.      any damages whether they be direct, indirect, special, consequential, 
  104.      or incidental    arising from a failure of this program to operate in 
  105.      the manner desired by the user.  Invariant Software shall not be 
  106.      liable for any damage to data or property which may be caused directly 
  107.      or indirectly by the use of this program.  THE PERSON USING THIS 
  108.      SOFTWARE ASSUMES ALL RISK AS TO THE QUALITY AND PERFORMANCE OF THIS 
  109.      SOFTWARE.
  110.  
  111.      RESPONSIBILITY of USER
  112.         This software is copyrighted under the U.S. copyright laws.  No 
  113.      person shall knowingly modify or distribute a modified version of this 
  114.      software.
  115.         Further, it is the responsibility of the user to pay for this 
  116.      software if they find it useful, and not to use any longer than a 
  117.      two week evaluation period.
  118.         This software is distributed as Shareware and may be freely 
  119.      distributed among other users within the limits as imposed above.
  120.      You are requested to pass this program out for trial use, and under 
  121.      no circumstances charge a fee other than the cost of a distribution 
  122.      disk.
  123.               
  124.      If you have any questions regarding ClearC, site licenses or if you 
  125.      have any suggestions, call 509-327-2154 and ask for Greg.
  126.  
  127.  
  128.  
  129.  
  130.      INVOICE/REGISTRATION for ClearC V1.1
  131.     
  132.      Send to:  Invariant Software        or        GSM                
  133.                P.O. Box 10206                      3117 W. Gordon
  134.                Spokane, WA 99209                   Spokane, WA  99205
  135.                                                    509-327-2154
  136.      
  137.      From:
  138.  
  139.      Name:         _____________________________________________
  140.  
  141.      Address:      _____________________________________________
  142.      City, State
  143.      and Zip Code: _____________________________________________
  144.  
  145.      Phone Number: _____________________________________________
  146.  
  147.      ( if applicatable )
  148.  
  149.      Company:      _____________________________________________
  150.  
  151.      Title:        _____________________________________________
  152.          
  153.          
  154.      Registration and notification of upgrades 
  155.      and other products .........................$30.00 ea.  _______
  156.      
  157.      Washington Residents add 7.8% Sales Tax ($2.34 ea.)...  _______
  158.     
  159.      Total Enclosed .......................................  _______
  160.  
  161.      Terms: Check Drawn on U.S. Bank in U.S. Funds,
  162.      International Bank or Postal Money Order
  163.             
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.